package cn.jetpiece.cloud.system.dp.api.biz;

import cn.jetpiece.cloud.model.page.PageResult;
import cn.jetpiece.cloud.model.response.Result;
import cn.jetpiece.cloud.resource.annotation.annotation.ApiResource;
import cn.jetpiece.cloud.resource.annotation.annotation.ScanResource;
import cn.jetpiece.cloud.system.dp.api.biz.model.params.CreateDpTSystemParam;
import cn.jetpiece.cloud.system.dp.api.biz.model.params.UpdateDpTSystemParam;
import cn.jetpiece.cloud.system.dp.api.biz.model.query.DpTSystemQuery;
import cn.jetpiece.cloud.system.dp.api.biz.model.result.DpTSystemResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMethod;

import javax.validation.Valid;

/**
 * 子系统信息表
 *
 * @author jetpiece
 * @since 2023-05-24
 */
@Api(tags="子系统信息表")
@ApiResource(name="子系统信息表")
public interface DpTSystemApi {

	String API = "/datapipeline/biz/dpTSystems";

	/**
	 * 新增子系统信息表
	 *
	 * @param param 新增参数
	 * @return 返回结果
	 */
	@ApiOperation(value = "新增子系统信息表")
	@ScanResource(name = "新增子系统信息表", path = API, method = RequestMethod.POST)
	Result<String> add(@RequestBody @Valid CreateDpTSystemParam param);

	/**
	 * 修改子系统信息表
	 *
	 * @param param 修改参数
	 * @return 返回结果
	 */
	@ApiOperation(value = "修改子系统信息表")
	@ScanResource(name = "修改子系统信息表", path = API, method = RequestMethod.PUT)
	Result<String> update(@RequestBody @Valid UpdateDpTSystemParam param);

	/**
	 * 删除子系统信息表
	 *
	 * @param id 主键
	 * @return 返回结果
	 */
	@ApiOperation(value = "删除子系统信息表")
	@ScanResource(name = "删除子系统信息表", path = API + "/{id}", method = RequestMethod.DELETE)
	Result<String> delete(@PathVariable(name = "id") Long id);

	/**
	 * 批量删除子系统信息表
	 *
	 * @param ids
	 * @return 返回结果
	 */
	@ApiOperation(value = "批量删除子系统信息表")
	@ScanResource(name = "批量删除子系统信息表", path = API + "/batch-del/{ids}", method = RequestMethod.DELETE)
	Result<String> deleteBatch(@PathVariable("ids") String ids);

	/**
	 * 查询子系统信息表信息
	 *
	 * @param id 主键
	 * @return 返回结果
	 */
	@ApiOperation(value = "查询子系统信息表信息")
	@ScanResource(name = "查询子系统信息表信息", path = API + "/{id}", method = RequestMethod.GET)
	Result<DpTSystemResult> get(@PathVariable(name = "id") Long id);

	/**
	 * 分页获取子系统信息表
	 *
	 * @param query 查询条件
	 * @return 返回结果
	 */
	@ApiOperation(value = "分页获取子系统信息表")
	@ScanResource(name = "分页获取子系统信息表", path = API, method = RequestMethod.GET)
	Result<PageResult<DpTSystemResult>> page(@Valid @SpringQueryMap DpTSystemQuery query);

}
